DOCSP-41965: Read and write settings #146

norareidy · 2024-09-23T18:13:59Z

Pull Request Info

After discussing with Caitlin, this PR reworks a section on the Databases and Collections guide (#136) into a full page

JIRA - https://jira.mongodb.org/browse/DOCSP-41965
Staging - https://deploy-preview-146--docs-php-library.netlify.app/read-write-pref/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2024-09-23T18:14:16Z

✅ Deploy Preview for docs-php-library ready!

Name	Link
🔨 Latest commit	`e48c5b4`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-php-library/deploys/66f2e0c8d6c2310008723098
😎 Deploy Preview	https://deploy-preview-146--docs-php-library.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

rustagir

good work, few changes req'd

rustagir · 2024-09-23T19:25:45Z

source/databases-collections.txt

-read and write operations on a replica set by setting a **read concern** and a
-**write concern**.
+You can control how read and write operations run on replica sets
+by specifying a read preference, read concern, and write concern.


Suggested change

by specifying a read preference, read concern, and write concern.

by specifying a read preference, read concern, or write concern.

rustagir · 2024-09-23T19:26:59Z

source/index.txt

@@ -17,6 +17,7 @@ MongoDB PHP Library
   /aggregation
   /indexes
   /security
+   /read-write-pref


S: I think that this section might be better suited to be under the read/write drawers

I wasn't sure whether to put it under read or write - I guess read if I had to choose, since there's more content on read settings configuration?

I dont think you need to put it in a drawer but just in the list under read and write

rustagir · 2024-09-23T19:27:33Z

source/read-write-pref.txt

+In this guide, you can learn how to use the **write concern**, **read concern**, and
+**read preference** configurations to modify the way that MongoDB runs
+create, read, update, and delete (CRUD) operations on replica sets.


Suggested change

In this guide, you can learn how to use the **write concern**, **read concern**, and

**read preference** configurations to modify the way that MongoDB runs

create, read, update, and delete (CRUD) operations on replica sets.

In this guide, you can learn how to configure **write concern**, **read concern**, and

**read preference** options to modify the way that MongoDB runs

create, read, update, and delete (CRUD) operations on replica sets.

rustagir · 2024-09-23T19:28:01Z

source/read-write-pref.txt

+--------
+
+In this guide, you can learn how to use the **write concern**, **read concern**, and
+**read preference** configurations to modify the way that MongoDB runs


Q: is mongodb the right subject here? or the library

rustagir · 2024-09-23T19:28:33Z

source/read-write-pref.txt

+example, if you set a read concern level for a transaction, it will override a read
+concern level set for the client.


Suggested change

example, if you set a read concern level for a transaction, it will override a read

concern level set for the client.

example, if you set a read concern level for a transaction, it will override a read

concern level inherited from the client.

rustagir · 2024-09-23T19:32:16Z

source/read-write-pref.txt

+    :dedent:
+    :start-after: start-session-settings
+    :end-before: end-session-settings
+


S: somewhere in this section you can note that you must instantiate the appropriate type to set the options (compared to client which took strings)

Or perhaps that info can go in client section and just inform that the syntax is different only for client

rustagir · 2024-09-23T19:33:23Z

source/read-write-pref.txt

+Tag Sets
+~~~~~~~~
+
+In {+mdb-server+}, you can apply key-value :manual:`tags


Suggested change

In {+mdb-server+}, you can apply key-value :manual:`tags

The {+mdb-server+} allows you to apply key-value :manual:`tags

rustagir · 2024-09-23T19:34:16Z

source/read-write-pref.txt

+    :language: php
+    :dedent:
+    :start-after: start-tag-set
+    :end-before: end-tag-set


S: indentation error

rustagir · 2024-09-23T19:35:30Z

source/read-write-pref.txt

+pass them as a parameter to your ``MongoDB\Driver\ReadPreference`` class
+constructor. Then, set the ``MongoDB\Driver\ReadPreference`` object as
+the value of the ``readPreference`` database option.
+


S: before the next paragraph, you could include a sentence here like:

Suppose you are connected to a replica set that contains members hosted at multiple data centers across the USA.

rustagir · 2024-09-23T19:36:51Z

source/includes/read-write-pref.php

+    'localThresholdMS' => 35,
+];
+
+$client = new Client('<connection string>', [], $options);


S: standardize the way connection strings are presented on the page (an earlier example uses the default local port)

rustagir

lgtm!

* Add PR template * Scaffolding * DOCSP-41953: Create a deployment (#93) * DOCSP-41953: Create a deployment * toc * add troubleshoot file * DOCSP-41954: Create a connection string (#99) * DOCSP-41954: Create a connection string * edits * spacing * DOCSP-42388: Next steps (#101) * DOCSP-41975: Retrieve data (#102) * DOCSP-41975: Retrieve data * fixes * quotes * code fix * JS feedback * JT feedback * code format * fix * JT feedback 2 * edit * DOCSP-41952: Download and Install (#92) * DOCSP-41952: Download and Install * edits * toc, fixes * AS feedback * AS feedback 2 * typo * JT feedback * DOCSP-41976: Projection guide (#104) * DOCSP-41976: Projection guide * edits * fixes * code edits, output * JS feedback * JT feedback * DOCSP-41955: Connect to MongoDB (#100) * DOCSP-41955: Connect to MongoDB * edits * edit * RR feedback * typo * code edit * DOCSP-41974: Specify a query (#103) * DOCSP-41974: Specify a query * edits * output * fix * snooty.toml * RR feedback * code edits * DOCSP-41977: Specify documents to return (#105) * DOCSP-41977: Specify documents to return * edits * code output * toc * MM feedback, code edits * edit * JT feedback * edit * test * MM feedback 2 * DOCSP-41957 - Mongo Client (#106) Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> * DOCSP-41960 - TLS (#114) * DOCSP-41978: Count documents (#108) * DOCSP-41978: Count documents * edits * code ex format * link * RR feedback * DOCSP-41979: Distinct values (#109) Adds a Distinct Values guide. * DOCSP-41981: Change streams (#113) Adds a Change Streams guide. * DOCSP-41993 Compatibility Table * test webhook * toc and sharedincludes * lang table * edits * headings * retry on shared include * shared includes * callout * help links * DOCSP-41958 - Connection Targets (#107) Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Andreas Braun <git@alcaeus.org> * tech review * DOCSP-41968: Update documents (#118) * DOCSP-41968: Update documents * snooty fix * edits * DOCSP-41967: Insert documents (#116) * DOCSP-41967: Insert documents * build * snooty * edit * JS feedback * JT feedback * JT feedback 2 * DOCSP-41980: Cursor guide (#110) * DOCSP-41980: Cursor guide * edits * code edits * output * vale fix * MM feedback * edit * fix code ex * edit * JT feedback * DOCSP-41988: Aggregation (#115) * DOCSP-41988: Aggregation * toc * edits * code edit * JS feedback * dev center * JM feedback * explain api link * JM feedback 2 * DOCSP-41983: indexes landing pg * wip * wip * MM PR fixes 1 * JM tech review 1 * JM tech review 1 * wip * wip * DOCSP-41969: Replace documents (#125) * DOCSP-41969: Replace documents * edits * wording * SA * JT feedback * JM tech review 2 * Add files via upload * DOCSP-41970: Delete documents (#128) Adds a guide that shows how to delete documents. * DOCSP-41984: single field index * wip * JS PR fixes 1 * wip * DOCSP-41986: multikey indexes * links * bullet pts * JS suggestion * fix whitespace per JM comment * uncomment * DOCSP-41985: compound idx * small fix * DOCSP-41966: Write operations landing (#135) * DOCSP-41966: Write operations landing * edits * RR feedback * JT feedback * JT feedback 2 * gridfs examples * DOCSP-42026: In use encryption (#142) * DOCSP-42026: In use encryption * edit * DOCSP-41972: GridFS guide (#133) * DOCSP-41972: GridFS guide * fixes * code edits * fix * RR feedback * phpmethod * fix * JM most feedback * alternate upload/download methods * file revisions * code fix * tojson * edits * JM feedback 2 * edits * JM last feedback * DOCSP-41971: Bulk write (#130) * DOCSP-41971: Bulk write * edits * JS feedback * api links * DOCSP-41987: atlas search idx * resolve todos * toc * DOCSP-41963: Databases and collections (#136) * DOCSP-41963: Databases and collections * edits * phpmethod * code fix * MW feedback * fix * MW feedback 2 * JM feedback * JM feedback 2 * JS fix * internal review * DOCSP-41982: cluster monitoring * small fixes * MW PR fixes 1 * test netlify * spacing * try using out of repo ref and add back legend * ou of repo ref * legend glitch * JM tech review 1 * single quotes * links * vale * remove older driver version past 1.15 * DOCSP-41991 What's New * add rest of versions * fix links * fix links * JM tech review 2 * DOCSP-41964: Time series collections (#138) * DOCSP-41964: Time series collections * toc * edits * keywords * SA feedback * JT feedback * JM final fixes * review comments * typo * DOCSP-41973 Read Landing Page * review comments * vale errors * small thing * full page with ex * add page * meta * DOCSP-41965: Read and write settings (#146) * DOCSP-41965: Read and write settings * more info * edits * edits * headers * fix link * fix * RR feedback * api docs * fix * fix * DOCSP-41950: Landing page (#150) * DOCSP-41950: Landing page * fix build errors * fixes, data formats * toc * fix * data formats folder * RR feedback * fix * remove file * edit sample app intro * change links in count sections * update sample app intro * DOCSP-41990: Authentication mechanisms (#139) * DOCSP-41990: Authentication mechanisms * client tabs * edits * edits * add info * reduce repetition * add section * fix link * MW feedback * fix * JM most feedback * move to code file * more JM edits * JM feedback 2 * DOCSP-41989: Security landing page (#149) * DOCSP-41989: Security landing page * more info * edits * snooty.toml * edits * RR feedback * JM feedback * DOCSP-41962 - Stable API (#117) Co-authored-by: Jeremy Mikola <jmikola@gmail.com> * DOCSP-41992 Upgrade versions * toc * edits * how to upgrade sections * style * edit * edit * review comments * ref * Revise descriptions for server opening/closed events * DOCSP-43204: Connection landing page (#147) * DOCSP-43204: Connection landing page * toc edit * edits * remove compression * fix * sample app * snooty * JM feedback * replica set * JM feedback 2 * JM last feedback * DOCSP-43819: php 1.20 release * fix * DOCSP-41956: run a command * wip * formatting fix * JS PR fixes 1 * link fix * style fixes * JT tech review 1 * wip * JM tech review * tree * api links * links * JM tech review 2 * small fixes * add ext upgrade command * DOCSP-41995: transaction * wip * update code * NR PR fixes 1 * wip * add emphasis * add with_txn() method to api links * cxn string env * edit * JM tech review 1 * remove dupe sc * tech review * wrap fix * edit copy * DOCSP-41959 - Connection Options (#112) Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com> * DOCSP-43396: Cleanup (#151) * DOCSP-43396: Cleanup * quickstart fix * code fixes * edit * snooty * edit * code output * build log errors * another build fix * add info * upgrade guide to landing * fix * driver mentions * RR feedback * build fix * build fix * php directives --------- Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> Co-authored-by: Lindsey Moore <lindsey.moore@mongodb.com> Co-authored-by: Andreas Braun <git@alcaeus.org> Co-authored-by: rustagir <rea.rustagi@mongodb.com> Co-authored-by: Brandon Ly <brandonly@lostcoding.com> Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

norareidy added 2 commits September 23, 2024 12:15

DOCSP-41965: Read and write settings

3d7ae37

more info

857753b

norareidy added 5 commits September 23, 2024 14:47

edits

2aab86a

edits

d0e6934

headers

0966a2a

fix link

e31a674

fix

79e3608

rustagir requested changes Sep 23, 2024

View reviewed changes

norareidy added 3 commits September 24, 2024 10:15

RR feedback

a36917d

api docs

1bcd46e

fix

2f570f5

norareidy requested a review from rustagir September 24, 2024 14:22

rustagir approved these changes Sep 24, 2024

View reviewed changes

fix

e48c5b4

norareidy requested review from a team and alcaeus and removed request for a team September 24, 2024 15:55

alcaeus approved these changes Sep 25, 2024

View reviewed changes

norareidy merged commit 16de291 into mongodb:php-standardization Sep 25, 2024
4 of 5 checks passed

norareidy deleted the DOCSP-41965-read-write-pref branch September 25, 2024 13:30

	by specifying a read preference, read concern, and write concern.
	by specifying a read preference, read concern, or write concern.

		example, if you set a read concern level for a transaction, it will override a read
		concern level set for the client.

	In {+mdb-server+}, you can apply key-value :manual:`tags
	The {+mdb-server+} allows you to apply key-value :manual:`tags

DOCSP-41965: Read and write settings #146

DOCSP-41965: Read and write settings #146

Uh oh!

Conversation

norareidy commented Sep 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

netlify bot commented Sep 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-php-library ready!

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

norareidy Sep 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

norareidy commented Sep 23, 2024 •

edited

Loading

netlify bot commented Sep 23, 2024 •

edited

Loading

norareidy Sep 24, 2024 •

edited

Loading